sddefinition module

class sd.api.sddefinition.SDDefinition(APIContext, handle, *args, **kwargs)

Bases: sd.api.sdapiobject.SDAPIObject

Describes a generic definition (of a node, a function, an item, …) with some common GUI infos and a set of SDProperty

getClassName() → str

Returns the most specific name of the class this APIObject is

getDescription() → str

Get the description of the definition

getId() → str

Get the identifier of the definition

getLabel() → str

Get the label of the definition

getProperties(sdPropertyCategory: sd.api.sdproperty.SDPropertyCategory) → Optional[sd.api.sdarray.SDArray[sd.api.sdproperty.SDProperty][sd.api.sdproperty.SDProperty]]

Get all properties matching the specified SDPropertyCategory

Parameters

sdPropertyCategory – The category of the properties

getPropertyFromId(sdPropertyId: str, sdPropertyCategory: sd.api.sdproperty.SDPropertyCategory) → Optional[sd.api.sdproperty.SDProperty]

Get property that matches the specified identifier in the specified category

Parameters

  • sdPropertyId – The identifier of the property we want to retrieve

  • sdPropertyCategory – The category of the property

release() → None

Releases an APIObject